v1.6.3

Compare Source

Bug Fixes

• docsearch not rendering properly (3e4120e)

v1.6.2

Compare Source

Bug Fixes

• fix static content removal for lean chunks due to Vue 3.5 changes (#​4508) (8214cae)

v1.6.1

Compare Source

Bug Fixes

• build: escape $ in replace pattern in dynamic routes plugin (e812916), closes #​4499
• theme/regression: broken hero heading at certain viewports (37dbe89)

v1.6.0

Compare Source

Bug Fixes

• build: out of order css in prod builds (241d17d), closes #​4098
• build: properly strip vpi-social css declaration in debug mode (c61182a)
• build: respect vite.clearScreen in build (8ea776a), closes #​4468
• build: specify mode for iconify (8a5e8ea)
• theme: apply externalLinkIcon option on VPHome (#​4492) (fe48943)
• theme: don't show external link icon for images (096bba1)
• theme: ignore footnote-ref for outline (1832617), closes #​4402
• theme: includes text to h1 tag for hero page (#​4472) (bd896c6), closes #​4453

Features

• build: export normalize function from shared chunk (616f63f), closes #​4401
• theme: allow customizing skip to content label (ff254dc), closes #​4288
• theme: export VPNavBarSearch (23522ab), closes #​4476
• theme: export VPFeatures (#​4356) (6442e17)

Miscellaneous

• build: shiki transformers now use v3 matching algorithm (373f9b9)

v1.5.0

Compare Source

Features

• on-demand social icons (#​4339) (05f2f0d), closes #​4256 #​4135 #​4076 #​3809 #​3750 #​1214 #​2768 #​2861

1.4.5 (2024-11-03)

Bug Fixes

• lang lazy load not working with twoslash (fc92a77), closes #​4334
• typo in missing language check (dcb8450)

1.4.3 (2024-10-31)

Performance Improvements

• lazy load shiki languages (#​4326) (8299778)

1.4.2 (2024-10-29)

Bug Fixes

• cache markdown-it instance and properly dispose shiki on config reload (#​4321) (45968cd) (acfe97f)
• regression: hmr not working with markdown includes due to wrong cache key (615aed5), closes #​4289 #​4303
• remove explicit chinese fonts (#​4286) (668e9f7) (b893550), closes #​4286
• theme/a11y: don't select search result unless mouse is actually moved (e638d85), closes #​4297
• theme: add types for VPLink, VPSocialLink and VPSocialLinks exports (#​4284) (fcae4d5)
• theme: don't escape html in siteTitle (#​4308) (bd690d6)

1.4.1 (2024-10-13)

Bug Fixes

• broken rewrites on windows (#​4268) (b46d6d3)
• client: use usePreferredDark with appearance: "force-auto" (#​4263) (3e8fc40)
• client: wrong script async check (461a5b0)
• theme: bind missing no icon prop in the menu link component #​4260 (b96712c)
• theme: improve local search input a11y (#​4066) (92b92ae)

Features

• experimental: support passing function for rewrites (#​4274) (8436472)

v1.4.5

Bug Fixes

• lang lazy load not working with twoslash (fc92a77), closes #​4334
• typo in missing language check (dcb8450)

v1.4.3

Compare Source

Performance Improvements

• lazy load shiki languages (#​4326) (8299778)

v1.4.2

Compare Source

Bug Fixes

• cache markdown-it instance and properly dispose shiki on config reload (#​4321) (45968cd) (acfe97f)
• regression: hmr not working with markdown includes due to wrong cache key (615aed5), closes #​4289 #​4303
• remove explicit chinese fonts (#​4286) (668e9f7) (b893550), closes #​4286
• theme/a11y: don't select search result unless mouse is actually moved (e638d85), closes #​4297
• theme: add types for VPLink, VPSocialLink and VPSocialLinks exports (#​4284) (fcae4d5)
• theme: don't escape html in siteTitle (#​4308) (bd690d6)

v1.4.1

Compare Source

Bug Fixes

• broken rewrites on windows (#​4268) (b46d6d3)
• client: use usePreferredDark with appearance: "force-auto" (#​4263) (3e8fc40)
• client: wrong script async check (461a5b0)
• theme: bind missing no icon prop in the menu link component #​4260 (b96712c)
• theme: improve local search input a11y (#​4066) (92b92ae)

Features

• experimental: support passing function for rewrites (#​4274) (8436472)

v1.4.0

Compare Source

Bug Fixes

• vueRE conflicting with lineNoRE (#​4247) (2ac64b8)
• hmr not updating page data in rewritten paths and file path is wrong in mdit for dynamic routes (c46e4b7), closes #​4172
• remove font synthesis in webfont mode, google fonts now support italic axis in inter (1628918)
• theme: change the order of CSS rules of VPFlyout (#​4225) (68150a6), closes #​4224
• theme: respect custom tag prop in VPButton component (#​4185) (9c5d348)

Features

• add data-title attribute for code group label tag (#​4152) (bc7271d)
• allow ignoring certain headers and their subtrees completely in outline (3e11b6a), closes #​4171
• client: add onAfterPageLoad hook in router (#​4126) (315c220)
• support adding extra attributes to snippet imports (useful for twoslash) (#​4100) (e8f7dd1)
• theme: expose theme default VPLink & VPSocialLink(s) component (#​4178) (615e33b)
• trigger onContentUpdated on frontmatter-only changes too (0db269a)

1.3.4 (2024-08-24)

Bug Fixes

• check if _importGlobMap (vite internal) exists before using it (612d66f)

1.3.3 (2024-08-17)

Miscellaneous

• bump deps (a20db24)

1.3.2 (2024-08-05)

Bug Fixes

• multiple cache busting imports causing useData to fail (2b3e486), closes #​3820, reverts #​3398, reopens #​3363
• theme: excerpt style in LocalSearchBox (#​4050) (2bc0d39)

1.3.1 (2024-07-14)

Bug Fixes

• don't reopen browser on restart when vite.server.open is specified (6263db1), closes #​4040
• theme/regression: typo in component props resulting in nested titles not showing in navbar (01d0d45), closes #​4042

v1.3.4

Compare Source

Bug Fixes

• check if _importGlobMap (vite internal) exists before using it (612d66f)

v1.3.3

Compare Source

Miscellaneous

• bump deps (a20db24)

v1.3.2

Compare Source

Bug Fixes

• multiple cache busting imports causing useData to fail (2b3e486), closes #​3820, reverts #​3398, reopens #​3363
• theme: excerpt style in LocalSearchBox (#​4050) (2bc0d39)

v1.3.1

Compare Source

Bug Fixes

• don't reopen browser on restart when vite.server.open is specified (6263db1), closes #​4040
• theme/regression: typo in component props resulting in nested titles not showing in navbar (01d0d45), closes #​4042

v1.3.0

Compare Source

Bug Fixes

• build: don't normalize links containing target or download property (e24899a), closes #​3947
• build: respect frontmatter.lastUpdated for pageData.lastUpdated and sitemap generation (7fcf462), closes #​3931
• build: sort pageToHashMap to ensure stable assets (e302328), closes #​4016
• client: do nothing on anchor elements with empty href (6461f5d), closes #​3950
• don't do git log on non-existent file (387acf7), closes #​4008
• don't reopen browser on restart (d837e82), closes #​4001
• properly handle svg anchor elements (b785bd6)
• theme: add styles for h4 too (b54d7b0)
• theme: deep watch sidebar groups and force render on match change (97f9469), closes #​3613
• theme: dim color for all text like elements inside blockquotes (5d3ed87), closes #​3929
• theme: force update title attribute on hydration (d348da7), closes #​4004
• theme: show filled nav bar when nav screen is open (0fc70e2)

Features

• allow using components in navigation bar (#​4000) (fa87d81)
• cli/init: allow passing target dir as command argument (#​3948) (99053ba)
• markdown: support including specific regions from markdown files (#​3978) (143b1e9)
• support force-auto as an option for appearance (1e8bb48), closes #​3946
• theme: export VPHomeContent (#​3960) (8aa6ccb), closes #​3954

1.2.3 (2024-06-04)

Bug Fixes

• theme,a11y: handle overflow on long mathematical equation and make tables focusable (#​3932) (closes #​3914) (afc611d)
• types: wrong types generated for markdown-it > mdurl (48ca76c), closes #​3935

1.2.2 (2024-05-21)

Bug Fixes

• dont escape ampersand twice in title (7ea3572)

1.2.1 (2024-05-21)

Bug Fixes

• a11y: make code blocks accessible with keyboard (#​3902) (cb308b9)
• escape title properly in build (49b1233)
• theme: remove unnecessary navigation role on nav element (af4717d)

v1.2.3

Compare Source

Bug Fixes

• theme,a11y: handle overflow on long mathematical equation and make tables focusable (#​3932) (closes #​3914) (afc611d)
• types: wrong types generated for markdown-it > mdurl (48ca76c), closes #​3935

v1.2.2

Compare Source

Bug Fixes

• dont escape ampersand twice in title (7ea3572)

v1.2.1

Compare Source

Bug Fixes

• a11y: make code blocks accessible with keyboard (#​3902) (cb308b9)
• escape title properly in build (49b1233)
• theme: remove unnecessary navigation role on nav element (af4717d)

v1.2.0

Compare Source

Bug Fixes

• build: show file info on error (f0debd2)
• dev: match dev and prod routing behavior (#​3837) (b360ac8)
• markdown: entities and escapes not working properly (#​3882) (d5dbd70)
• render 404 page completely on client to infer locale from browser path (#​3858) (728cb15)
• style: prefer YaHei over DengXian (f0a37b4)
• theme/regression: custom font not applying in Chinese docs because of specificity (fa2f38a), closes #​3864
• theme: external link icon not visible for target _blank links (d08eeed), closes #​3327
• theme: fix invalid vp-offset in ssr (9794877)

Features

• build/i18n: support customizing copy code button's tooltip text (#​3854) (ed6ada7)
• build: add localeIndex to md.env (#​3862) (0cbb469)

1.1.4 (2024-04-27)

Bug Fixes

• dev: multiple server instances being created when editing config too quickly (#​3835) (729a890)
• theme/a11y: add unique name to footer prev / next navigation landmark (e60c101)
• theme/a11y: remove duplicate assistive text from outline nav (#​3803) (733d986)
• theme/i18n: 404 page not showing localized text (#​3833) (cc11b8e)
• theme: disable keypress effect on search button (ccc37bb)
• theme: don't use Chinese quotes on non-Chinese documents (#​3834) (75115f4)
• theme: leaking event listener when going back/forward on Safari on iOS (#​3658) (#​3671) (1a72181)

1.1.3 (2024-04-18)

Bug Fixes

• build/regression: markdown backslash escapes not working (d02d1e9), closes #​3808

1.1.1 (2024-04-18)

Bug Fixes

• client: don't reload page on hash change (#​3777) (74b725a)
• let vue compiler handle entity decoding (f86ac56)
• hot updating config file suppresses error logs (#​3592) (cd5adf3)

v1.1.4

Compare Source

Bug Fixes

• dev: multiple server instances being created when editing config too quickly (#​3835) (729a890)
• theme/a11y: add unique name to footer prev / next navigation landmark (e60c101)
• theme/a11y: remove duplicate assistive text from outline nav (#​3803) (733d986)
• theme/i18n: 404 page not showing localized text (#​3833) (cc11b8e)
• theme: disable keypress effect on search button (ccc37bb)
• theme: don't use Chinese quotes on non-Chinese documents (#​3834) (75115f4)
• theme: leaking event listener when going back/forward on Safari on iOS (#​3658) (#​3671) (1a72181)

v1.1.3

Compare Source

Bug Fixes

• build/regression: markdown backslash escapes not working (d02d1e9), closes #​3808

v1.1.2

Compare Source

v1.1.1

Compare Source

Bug Fixes

• client: don't reload page on hash change (#​3777) (74b725a)
• let vue compiler handle entity decoding (f86ac56)
• hot updating config file suppresses error logs (#​3592) (cd5adf3)

v1.1.0

Compare Source

Bug Fixes

• client: hashchange should only be triggered for same page navigations (#​3768) (2a9fc2a)
• client: emit correct Event instance in hashchange event
• theme: remove small layout shift on On this page button (#​3767) (5f28e74)

Features

• client: add hash property to useData()
• theme: update Inter to version 4 (#​3693) (#​3694) (ffafa31)

1.0.2 (2024-04-01)

Bug Fixes

• theme: text containing html not showing properly in mobile nav menu (3c8b4c7)

1.0.1 (2024-03-22)

Bug Fixes

• build: vendor vue-demi to avoid resolution issues with yarn berry (#​3680) (5d3cb96)

v1.0.2

Compare Source

Bug Fixes

• theme: text containing html not showing properly in mobile nav menu (3c8b4c7)

v1.0.1

Compare Source

Bug Fixes

• build: vendor vue-demi to avoid resolution issues with yarn berry (#​3680) (5d3cb96)

v1.0.0

Compare Source

Bug Fixes

• build: resolve pattern relative to srcDir instead of root in createContentLoader (#​3638) (59183e9)
• localSearch: remove empty titles that may appear in search results (#​3665) (f7aef3c)
• theme: fixed sidebar expand caret showing when no children are present (#​3657) (e13f932)
• theme: ignore inner-page items in next/prev link (#​3663) (b50a8a1)
• theme: local nav separator not visible on pages having no outline (1909041)

Features

• theme: allow selectively disabling external link icon on navbar items (#​3607) (5f6297c)

v1.0.0-rc.45

Compare Source

Bug Fixes

• router: hashchange not emitted in certain cases (#​3637) (f6bd99e...6c0125b)

Features

• set __VITEPRESS__ for easy detection by plugins and other tools (#​3634) (f6bd99e)

v1.0.0-rc.44

Compare Source

Reverts

• types for internal components (e703429)

v1.0.0-rc.43

Compare Source

Bug Fixes

• handle process.env being undefined while process is not (b63e0a0), closes #​3579
• make local search work in combination with vue-i18n (#​3559) (6624bb7)
• theme: adjust mathjax svg styles (#​3567) (2051100)

Features

• theme: auto style markdown content in home page (#​3561) (0903027)

Performance Improvements

• theme: move svg icons to css (#​3537) (636cca0)

BREAKING CHANGES

• The default theme now styles the markdown content in the home page. If you have custom styles that rely on the markdown content not being styled, you may need to adjust your styles, or add markdownStyles: false to the frontmatter of your home page.

v1.0.0-rc.42

Compare Source

Bug Fixes

• md: dont break on nesting blockquotes inside gfm alerts (8f8a6fe), closes #​3512
• theme: correctly normalize paths ending with "index" (#​3544) (c582a8d)

v1.0.0-rc.41

Compare Source

Bug Fixes

• handle CRLF in snippet plugin (5811b62), closes #​3499
• lazy evaluate known extensions to allow env set in config (04f794b)

Features

• home: add target and rel attribute to home actions (#​3528) (ab39fd8)
• rename shiki packages (#​3506) (b8487d3)
• wrap site title in span (#​3522) (6b1f951)
• theme: add hero slots that are inside container (#​3524) (28870e6)

BREAKING CHANGES

• vitepress now uses shiki instead of shikiji. If you’re on the latest version and using shikiji specific features, you just need to change imports. The shikijiSetup hook is renamed to shikiSetup.

v1.0.0-rc.40

Compare Source

Bug Fixes

• client: handle head orphans added in initial load (#​3474) (5e2d853)
• theme: avoid selecting summary on toggling details (77a318c)
• theme: hover color for code links inside custom containers (#​3467) (d529ed4)
• type: fix missed VPBadge type in theme.d.ts (#​3470) (fcf828c)

Features

• support GitHub-flavored alerts (#​3482) (ac87d19)
• support specifying custom extensions to escape routing (#​3466) (c22f5d9)
• theme: add npm icon (#​3483) (c882fa1)

v1.0.0-rc.39

Compare Source

Bug Fixes

• theme: misaligned outline indicator (#​3458) (0ce5ece)
• theme: enter key behavior conflict with IME in search box (#​3454) (cd8ee6f)
• theme: use--vp-c-tip- CSS variable for badge/block colors with typetip (#​3434) (78abf47)

Features

• theme: export VPBadge (#​3431) (18981c1)

v1.0.0-rc.38

Compare Source

v1.0.0-rc.37

Compare Source

v1.0.0-rc.36

Compare Source

Bug Fixes

• avoid pushing to history when clicking on the current link (#​3405) (d279e63)
• theme/regression: external link icon not working (c236570), closes #​3424
• theme/regression: inter getting bundled even importing without-fonts entry (#​3412) (b03fb83)

v1.0.0-rc.35

Compare Source

Bug Fixes

• client: add computed dir and lang to html root (c2b4c66), closes #​3353
• fill all empty code lines (563020b), closes #​3305
• fix theme chunking logic causing out-of-order styles (#​3403) (a6cd891)
• invalidate module cache for subsequent builds (#​3398) (27f60e0)

Features

• allow passing options to emoji plugin (09e48db), closes #​3174
• theme: allow specifying rel and target in logoLink (6c89943), closes #​3264 #​3271

Performance Improvements

• localSearch: add concurrency pooling, cleanup logic, improve performance (#​3374) (ac5881e)

v1.0.0-rc.34

Compare Source

Bug Fixes

• build: clear cache after build (9568fea), closes #​3363
• default-theme: remove use of reactify for search i18n (8687b86)
• print errors when importing an invalid dynamic route (#​3201) (6d89a08)
• remove double title from home pages (9f1f04e), closes #​3375
• theme/i18n: support customizing dark mode switch titles (#​3311) (50c9758)

Features

• support custom image lazy loading (#​3346) (55be3f1)
• support dir in frontmatter (#​3353) (203446d)
• theme/i18n: allow customizing sponsor link's text (#​3276) (9c20e3b)
• theme: allow using VPBadge classes in sidebar (#​3391) (50a774e)
• theme: new design for local nav and global header (#​3359) (d10bf42)

v1.0.0-rc.33

Compare Source

Features

• allow explicitly mark code element as .vp-copy-ignore (#​3360) (93122ee)
• build: enable VUE_PROD_HYDRATION_MISMATCH_DETAILS when DEBUG is truthy (f4d4280), closes #​422

Performance Improvements

• implement concurrent promise pooling for render task (#​3366)

v1.0.0-rc.32

Compare Source

Features

• allow ignoring node in header (#​3331) (e4bf1e4)
• expose shikijiSetup hook (#​3344) (d12e23d)
• update shikiji, support twoslash (#​3339) (8800195)

v1.0.0-rc.31

Compare Source

Bug Fixes

• build: make assets go through vite pipeline during dev too (#​3258) ([c3